home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 1998 November / IRIX 6.5.2 Base Documentation November 1998.img / usr / share / catman / p_man / cat3 / Xm / XmCreateOptionMenu.z / XmCreateOptionMenu
Text File  |  1998-10-30  |  10KB  |  199 lines
  1.  
  2.  
  3.  
  4.      XXXXmmmmCCCCrrrreeeeaaaatttteeeeOOOOppppttttiiiioooonnnnMMMMeeeennnnuuuu((((3333XXXX))))    UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV    XXXXmmmmCCCCrrrreeeeaaaatttteeeeOOOOppppttttiiiioooonnnnMMMMeeeennnnuuuu((((3333XXXX))))
  5.  
  6.  
  7.  
  8.      NNNNAAAAMMMMEEEE
  9.           XXXXmmmmCCCCrrrreeeeaaaatttteeeeOOOOppppttttiiiioooonnnnMMMMeeeennnnuuuu - A RowColumn widget convenience creation
  10.           function
  11.  
  12.      SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  13.           #include <Xm/RowColumn.h>
  14.           WWWWiiiiddddggggeeeetttt XXXXmmmmCCCCrrrreeeeaaaatttteeeeOOOOppppttttiiiioooonnnnMMMMeeeennnnuuuu(
  15.           WWWWiiiiddddggggeeeetttt ppppaaaarrrreeeennnntttt,
  16.           SSSSttttrrrriiiinnnngggg nnnnaaaammmmeeee,
  17.           AAAArrrrggggLLLLiiiisssstttt aaaarrrrgggglllliiiisssstttt,
  18.           CCCCaaaarrrrddddiiiinnnnaaaallll aaaarrrrggggccccoooouuuunnnntttt);
  19.  
  20.      VVVVEEEERRRRSSSSIIIIOOOONNNN
  21.           This page documents Motif 2.1.
  22.  
  23.      DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  24.           XXXXmmmmCCCCrrrreeeeaaaatttteeeeOOOOppppttttiiiioooonnnnMMMMeeeennnnuuuu creates an instance of a RowColumn widget
  25.           of type XXXXmmmmMMMMEEEENNNNUUUU____OOOOPPPPTTTTIIIIOOOONNNNand returns the associated widget ID.
  26.  
  27.           It is provided as a convenience function for creating a
  28.           RowColumn widget configured to operate as an OptionMenu and
  29.           is not implemented as a separate widget class.
  30.  
  31.           The OptionMenu widget is a specialized RowColumn manager
  32.           composed of a label, a selection area, and a single Pulldown
  33.           menu pane. When an application creates an OptionMenu widget,
  34.           it supplies the label string and the Pulldown menu pane.  In
  35.           order for the operation to be successful, there must be a
  36.           valid XXXXmmmmNNNNssssuuuubbbbMMMMeeeennnnuuuuIIIIdddd resource set when this function is
  37.           called.  The LabelGadget and the selection area (a
  38.           CascadeButtonGadget) are created by the OptionMenu.
  39.  
  40.           The OptionMenu's Pulldown menu pane must not contain any
  41.           ToggleButtons or ToggleButtonGadgets.  The results of
  42.           including CascadeButtons or CascadeButtonGadgets in the
  43.           OptionMenu's Pulldown menu pane are undefined.
  44.  
  45.           An OptionMenu is laid out with the label displayed on one
  46.           side of the widget and the selection area on the other side
  47.           when XXXXmmmmNNNNoooorrrriiiieeeennnnttttaaaattttiiiioooonnnn is _X_m_H_O_R_I_Z_O_N_T_A_L.  The layout of the
  48.           label with respect to the selection area depends on the
  49.           XXXXmmmmNNNNllllaaaayyyyoooouuuuttttDDDDiiiirrrreeeeccccttttiiiioooonnnn resource in the horizontal orientation.
  50.           If the value is XXXXmmmmVVVVEEEERRRRTTTTIIIICCCCAAAALLLL, the label is above the selection
  51.           area.  The selection area has a dual purpose; it displays
  52.           the label of the last item selected from the associated
  53.           Pulldown menu pane, and it provides the means for posting
  54.           the Pulldown menu pane.
  55.  
  56.           The OptionMenu typically does not display any 3-D visuals
  57.           around itself or the internal LabelGadget. By default, the
  58.           internal CascadeButtonGadget has a visible 3-D shadow.  The
  59.           application may change this by getting the
  60.  
  61.  
  62.  
  63.      Page 1                                         (printed 10/24/98)
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.      XXXXmmmmCCCCrrrreeeeaaaatttteeeeOOOOppppttttiiiioooonnnnMMMMeeeennnnuuuu((((3333XXXX))))    UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV    XXXXmmmmCCCCrrrreeeeaaaatttteeeeOOOOppppttttiiiioooonnnnMMMMeeeennnnuuuu((((3333XXXX))))
  71.  
  72.  
  73.  
  74.           CascadeButtonGadget ID using XXXXmmmmOOOOppppttttiiiioooonnnnBBBBuuuuttttttttoooonnnnGGGGaaaaddddggggeeeetttt, and then
  75.           calling XXXXttttSSSSeeeettttVVVVaaaalllluuuueeeessss using the standard visual-related
  76.           resources.
  77.  
  78.           The Pulldown menu pane is posted when the mouse pointer is
  79.           moved over the selection area and a mouse button that is
  80.           defined by OptionMenu's RowColumn parent is pressed.  The
  81.           Pulldown menu pane is posted and positioned so that the last
  82.           selected item is directly over the selection area. The mouse
  83.           is then used to arm the desired menu item. When the mouse
  84.           button is released, the armed menu item is selected and the
  85.           label within the selection area is changed to match that of
  86.           the selected item. By default, BBBBSSSSeeeelllleeeecccctttt is used to interact
  87.           with an OptionMenu.  The default can be changed with the
  88.           RowColumn resource XXXXmmmmNNNNmmmmeeeennnnuuuuPPPPoooosssstttt.
  89.  
  90.           The OptionMenu also operates with the keyboard interface
  91.           mechanism.  If the application has established a mnemonic
  92.           with the OptionMenu, pressing <<<<AAAAlllltttt>>>> with the mnemonic causes
  93.           the Pulldown menu pane to be posted with traversal enabled.
  94.           The standard traversal keys can then be used to move within
  95.           the menu pane. Pressing <<<<RRRReeeettttuuuurrrrnnnn>>>> or typing a mnemonic or
  96.           accelerator for one of the menu items selects that item.
  97.  
  98.           An application may use the XXXXmmmmNNNNmmmmeeeennnnuuuuHHHHiiiissssttttoooorrrryyyy resource to
  99.           indicate which item in the Pulldown menu pane should be
  100.           treated as the current choice and have its label displayed
  101.           in the selection area. By default, the first selectable item
  102.           in the Pulldown menu pane is used.
  103.  
  104.           _p_a_r_e_n_t    Specifies the parent widget ID
  105.  
  106.           _n_a_m_e      Specifies the name of the created widget
  107.  
  108.           _a_r_g_l_i_s_t   Specifies the argument list
  109.  
  110.           _a_r_g_c_o_u_n_t  Specifies the number of attribute/value pairs in
  111.                     the argument list (_a_r_g_l_i_s_t)
  112.  
  113.           The user can specify resources in a resource file for the
  114.           automatically created widgets and gadgets of an OptionMenu.
  115.           These widgets (or gadgets) and the associated OptionMenu
  116.           areas are
  117.  
  118.           Option Menu Label Gadget
  119.                     OOOOppppttttiiiioooonnnnLLLLaaaabbbbeeeellll
  120.  
  121.           Option Menu Cascade Button
  122.                     OOOOppppttttiiiioooonnnnBBBBuuuuttttttttoooonnnn
  123.  
  124.           For a complete definition of RowColumn and its associated
  125.           resources, see XXXXmmmmRRRRoooowwwwCCCCoooolllluuuummmmnnnn(3).
  126.  
  127.  
  128.  
  129.      Page 2                                         (printed 10/24/98)
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136.      XXXXmmmmCCCCrrrreeeeaaaatttteeeeOOOOppppttttiiiioooonnnnMMMMeeeennnnuuuu((((3333XXXX))))    UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV    XXXXmmmmCCCCrrrreeeeaaaatttteeeeOOOOppppttttiiiioooonnnnMMMMeeeennnnuuuu((((3333XXXX))))
  137.  
  138.  
  139.  
  140.      RRRREEEETTTTUUUURRRRNNNN
  141.           Returns the RowColumn widget ID.
  142.  
  143.      RRRREEEELLLLAAAATTTTEEEEDDDD
  144.           XXXXmmmmCCCCaaaassssccccaaaaddddeeeeBBBBuuuuttttttttoooonnnnGGGGaaaaddddggggeeeetttt(3), XXXXmmmmCCCCrrrreeeeaaaatttteeeePPPPuuuullllllllddddoooowwwwnnnnMMMMeeeennnnuuuu(3),
  145.           XXXXmmmmCCCCrrrreeeeaaaatttteeeeSSSSiiiimmmmpppplllleeeeOOOOppppttttiiiioooonnnnMMMMeeeennnnuuuu(3), XXXXmmmmLLLLaaaabbbbeeeellllGGGGaaaaddddggggeeeetttt(3),
  146.           XXXXmmmmOOOOppppttttiiiioooonnnnBBBBuuuuttttttttoooonnnnGGGGaaaaddddggggeeeetttt(3), XXXXmmmmOOOOppppttttiiiioooonnnnLLLLaaaabbbbeeeellllGGGGaaaaddddggggeeeetttt(3),
  147.           XXXXmmmmRRRRoooowwwwCCCCoooolllluuuummmmnnnn(3), and XXXXmmmmVVVVaaaaCCCCrrrreeeeaaaatttteeeeSSSSiiiimmmmpppplllleeeeOOOOppppttttiiiioooonnnnMMMMeeeennnnuuuu(3).
  148.  
  149.  
  150.  
  151.  
  152.  
  153.  
  154.  
  155.  
  156.  
  157.  
  158.  
  159.  
  160.  
  161.  
  162.  
  163.  
  164.  
  165.  
  166.  
  167.  
  168.  
  169.  
  170.  
  171.  
  172.  
  173.  
  174.  
  175.  
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.      Page 3                                         (printed 10/24/98)
  196.  
  197.  
  198.  
  199.